/*
 * Copyright (c) 2019 Spotify AB.
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package com.spotify.heroic.http.metadata

import com.spotify.heroic.QueryDateRange
import com.spotify.heroic.filter.Filter
import java.util.*

data class MetadataTagValuesSuggest(
    // Filter the suggestions being returned.
    val filter: Optional<Filter>,
    // Limit the number of suggestions being returned.
    val limit: Optional<Long>,
    // Query for tags within the given range.
    val range: Optional<QueryDateRange>,
    // Exclude the given tags from the result.
    val exclude: Optional<List<String>>,
    // Limit the number of values a single suggestion group may contain.
    val groupLimit: Optional<Long>
) {
    companion object {
        const val DEFAULT_LIMIT: Long = 10
        const val DEFAULT_GROUP_LIMIT: Long = 10
    }
}